CygNet Studio > Using CygNet Studio Tools and Controls > CygNet NOTE View Control > Properties, Events, and Methods > Properties

CygNet NOTE View Control – Properties

The following table lists and describes properties of the CygNet NOTE View Control as they are exposed on the Property Sheet and/or in the control's script editor (via the CxNoteServiceCtrl object).

Property Sheet

Script Editor

Description

Appearance

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 - Flat or 1 - 3D. Default is 0 - Flat.

BorderStyle

BorderStyle

BorderStyle specifies the border style of the object boundary.

  • 0 - None or 1 - Fixed Single. Default is 0 - None.

Bottom

N/A

Bottom specifies the distance in pixels from the top of the object to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object.

CursorPointer

N/A

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 - Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

  • 1 - Arrow
  • 2 - IBeam
  • 3 - Cross
  • 4 - UpArrow
  • 5 - NoDrop
  • 6 - Help
  • 99 - HotSpot
  • 100 - Timer

Script subtype is long.

N/A

DeleteEnabled

DeleteEnabled specifies whether the user can delete a note from the view. Options are 0 - No and 1 - Yes.

Enable

N/A

Enable specifies whether the user is able to interact with the object. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If set to 0 - No, the object is still visible but its context menu is disabled.

Other options:

  • Completely hide the object in run mode using the Visible property.
  • Display the object but hide its [DisplayItem] using the [DisplayElement] property.

FlexHorizontal

N/A

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

  • 0 - None (no resizing occurs)
  • 1 - Shift (the object is shifted)
  • 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame)
  • 3 - Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 - None.

FlexVertical

N/A

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

  • 0 - None (no resizing occurs)
  • 1 - Shift (the object is shifted)
  • 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame)
  • 3 - Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 - None.

Group

N/A

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 - No and 1 - Yes. The default is 0 - No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 - Yes for the first object in the group.

5. Set Group set to 0 - No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 - Yes and 2) that use a Group property set to 0 - No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

HelpContextID

N/A

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

HideDataKey

HideDataKey

HideDataKey hides/displays a column in the service pane that shows the database key value for each record. Options are 0 - No and 1 - Yes.

IndexFilter

IndexFilter

IndexFilter gets/sets the default index used by the control.

Rather than use the Select Search to change the control to a different index, specify the default index prefix to use as the default. The index prefix are found in the Index Definitions list of the service's .ddl file:

  • NA — Note Association Index (Start Time)
  • NE — Note Header Index (End Time)
  • NR — Note Header Index (Duration)
  • NS — Note Start Time Index (Start, Type, Author) (Default)
  • NT — Note Type Index (Type, Start, Author)
  • N1 — Note Association Index (End Time)
  • N3 — Note Association Index
  • N4 — Note Association Index
  • N5 — Note Association Index
  • N6 — Note Association Index (Duration)

Layer

N/A

Layer identifies the layer on which the object resides. Script subtype is Boolean.

Left

N/A

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object.

NewEnabled

NewEnabled

NewEnabled specifies whether the user can add a note to the view. Options are 0 - No and 1 - Yes.

(ObjectCode)

N/A

(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.

PropertiesEnabled

PropertiesEnabled

PropertiesEnabled specifies whether the user can view the Properties dialog box for a not in the view. Options are 0 - No and 1 - Yes.

Right

N/A

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object.

SiteService

SiteService

SiteService gets/sets the Site.Service to which the control will connect.

Note: It is necessary to set this property in the script in order to trigger the control to load the notes list.

Tabstop

N/A

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 - No and 1 - Yes. Default is 1 - Yes.

Script subtype is long.

See also Group and Tab Order.

Note: To set the tab order, use the Objects option on the Layout menu.

Tag

N/A

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

Top

N/A

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the Top of the object.

Visible

N/A

Visible secifies whether the object is visible in Run mode. Options are 0 - No or 1 - Yes. Default is 1 - Yes.

Note: Objects are always visible in Edit mode, regardless of how this property value is set.

You can also:

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.